[BETA] Marketplace-level Forecasts

curl --request GET \
  --url https://api.topsort.com/public/v1/toptimize/forecasting/marketplace \
  --header 'Authorization: Bearer <token>'

[
  {
    "forecastDate": "2023-12-25",
    "metrics": [
      {
        "metricName": "<string>",
        "values": {
          "forecastValue": 123,
          "forecastIntervalMin": 123,
          "forecastIntervalMax": 123
        }
      }
    ]
  }
]

Forecasting Service

[BETA] Marketplace-level Forecasts

Get marketplace forecasts for the given time window.

⚠️ Beta Access Required

Contact your sales representative to gain access to this endpoint and start using it.

It returns a list of daily forecasts for the following metrics:

Total number of auctions.
Total number of slots.
Total number of winners.
Total number of impressions.
Total number of clicks.
Average CPC.
Average CTR.
Slot occupancy (Proportion of slots that are occupied).
Total capacity (represents the potential revenue that could be generated under optimal conditions).
Occupied capacity (reflects the actual revenue generated from effective winners and active campaigns).

GET

public

toptimize

forecasting

marketplace

[BETA] Marketplace-level Forecasts

curl --request GET \
  --url https://api.topsort.com/public/v1/toptimize/forecasting/marketplace \
  --header 'Authorization: Bearer <token>'

[
  {
    "forecastDate": "2023-12-25",
    "metrics": [
      {
        "metricName": "<string>",
        "values": {
          "forecastValue": 123,
          "forecastIntervalMin": 123,
          "forecastIntervalMax": 123
        }
      }
    ]
  }
]

Authorizations

Authorization

string

header

required

A valid API key generated in Topsort's UI.

Query Parameters

time_window

integer

default:7

How many days to forecast into the future.

Response

Successful Response

forecastDate

string<date>

required

Date of the forecast

metrics

MetricForecast · object[]

required

List of metric forecasts for this date

Show child attributes

metrics.metricName

string

required

Name of the metric being forecasted

metrics.values

ForecastMetricValue · object

required

Forecast values for this metric

Show child attributes

metrics.values.forecastValue

number

required

The forecasted value

metrics.values.forecastIntervalMin

number

required

The lower bound of the confidence interval

metrics.values.forecastIntervalMax

number

required

The upper bound of the confidence interval

Get Campaign Daily Report [BETA] Inventory-level Forecasts

⌘I

General

Auction examples

Webhook examples

Auctions

Events

Toptimize

Toppie API

Campaign API

Catalog API

Billing API

Reporting API

Invitation API

User API

Webhooks API

Assets API

Segments Service

Offsite Ads API

Forecasting Service

Media API

API Reference

[BETA] Marketplace-level Forecasts

Authorizations

Query Parameters

Response